home *** CD-ROM | disk | FTP | other *** search
/ Shareware Grab Bag / Shareware Grab Bag.iso / 011 / syslog.arc / SYSLOG.DOC next >
Text File  |  1985-01-15  |  19KB  |  573 lines
  1.  
  2.  
  3.  
  4.  
  5.  
  6.  
  7.  
  8.  
  9.  
  10.           ====================================================
  11.  
  12.                          tm
  13.                   S Y S L O G
  14.  
  15.             System Log Utility User's Manual
  16.  
  17.                   by R W Cobb
  18.  
  19.  
  20.  
  21.                   Version 1.1
  22.  
  23.                PC/MS-DOS 2.0 or Greater
  24.  
  25.  
  26.           (C) Copyright 1984 by R W Cobb, All Rights Reserved
  27.  
  28.           ====================================================
  29.  
  30.  
  31.  
  32.  
  33.  
  34.  
  35.  
  36.  
  37.  
  38.  
  39.  
  40.           L I C E N S E   A G R E E M E N T __________________
  41.  
  42.  
  43.           SYSLOG is published by Apex Resource, 23 Christine
  44.           Court, Stormville, NY  12582.
  45.  
  46.           A limited license is granted to all users of this
  47.           program to make copies of this program and
  48.           accompanying documentation and distribute them to
  49.           other users on the following conditions:
  50.  
  51.           1.  No fee or other consideration is to be charged
  52.           for copying or distributing the program without
  53.           the express written permission of Apex Resource.
  54.  
  55.           2.  The program and its documentation are not to be
  56.           distributed in modified form.
  57.  
  58.           SYSLOG is a trademark of Apex Resource.
  59.  
  60.           ____________________________________________________
  61.  
  62.  
  63.  
  64.  
  65.           S Y S L O G ________________________________________
  66.  
  67.  
  68.           User Supported Software
  69.  
  70.           If you are using this program and finding it of
  71.           value, you are encouraged to register your copy with
  72.           Apex Resource.
  73.  
  74.           Registration of your program entitles you to
  75.           the following:
  76.  
  77.           1.  Production copy of the program, including
  78.           a program binder, serialized diskette, and
  79.           manual.
  80.  
  81.           2.  Notification of any updates to the program.
  82.  
  83.           3.  Free upgrades, when you return your original
  84.           serialized program diskette with a postage paid
  85.           return mailer.
  86.  
  87.           A one time registration fee of $25.00 (a legitimate
  88.           tax deductable expense for business users) is all
  89.           that is required.
  90.  
  91.           For your convenience, a registration form is
  92.           included in Appendix A, and yes we do accept credit
  93.           cards.
  94.  
  95.           Apex Resource also publishes other high quality, low
  96.           cost software for microcomputers, including:
  97.  
  98.           Pascal Programmer's Toolbox - A collection of
  99.             assembly language procedures and functions
  100.             that include support for displays,
  101.             printers, keyboard, strings, and speaker.
  102.  
  103.           Print Command - A printer utility for the Epson
  104.             printers to allow you to create and use
  105.             new fonts and setup print styles.
  106.  
  107.           ____________________________________________________
  108.  
  109.                      -1-
  110.  
  111.  
  112.  
  113.           WHAT IS SYSLOG _____________________________________
  114.  
  115.           Syslog is a utility program which semi-automaticaly
  116.           logs the usage of computer time.    Information logged
  117.           includes login date/time, operator, project name,
  118.           and logout date/time.
  119.  
  120.           For many years, tax experts have said that computer
  121.           expenses being deducted at tax time may be
  122.           challenged in the event of an audit.  Since most
  123.           computer owners have no evidence to prove the actual
  124.           percentage of computer time used for business
  125.           purposes, the IRS frequently disallows the
  126.           deduction.  Tax experts agree, however, that the
  127.           most effective means of substantiating such a claim
  128.           is a log.
  129.  
  130.           For some people, this sensible advice would be
  131.           reason enough to start a log immediately.
  132.           Unfortunately, most of us are not endowed with that
  133.           much discipline.    Well then, for the rest of us
  134.           there is now an even better reason.
  135.  
  136.           On July 18, 1984 a new tax law went into effect.
  137.           The Deficit Reduction Act of 1984 states in one of
  138.           its provisions that personal property used less
  139.           than 50% for business purposes is subject to a new
  140.           restriction.  A log of the properties business uses
  141.           must be maintained.
  142.  
  143.           Syslog provides the log you will need to support
  144.           your tax deduction, and does so in a relatively
  145.           unobtrusive way.    Since your computer will keep
  146.           accurate date and time data, all you need to provide
  147.           for the log is the operators initials and a
  148.           description of what project is being done.
  149.  
  150.           For your information, Syslog was written in
  151.           MS-Pascal ver 3.2, and was compiled to run under
  152.           MS-DOS 2.0 or greater OS's.  A new version of this
  153.           program is currently 'under construction' and is
  154.           being written in 'C'.  The improvements are aimed at
  155.           reducing the size of the program, as well as adding
  156.           some new features.
  157.  
  158.           ____________________________________________________
  159.  
  160.                      -2-
  161.  
  162.  
  163.  
  164.           SYSTEM REQUIREMENTS ________________________________
  165.  
  166.           The following configuration is the minimum which is
  167.           required to access all of the features of Syslog.
  168.  
  169.             Minimum Configuration
  170.             ---------------------
  171.  
  172.             o  IBM PC/jr/XT/AT or Compatible w/128K
  173.  
  174.             o  Disk Drive, Double Sided Prefered
  175.  
  176.             o  Monochrome or Color Display
  177.  
  178.             o  Printer
  179.  
  180.             o  PC/MS-DOS 2.0 or greater
  181.  
  182.           It is recommended that the following optional
  183.           equipment be available to improve program
  184.           performance.
  185.  
  186.             Optional Equipment
  187.             ------------------
  188.  
  189.             o  Clock/Calendar Card w/software to set
  190.                date/time
  191.  
  192.           Although we have not tried to run Syslog on any
  193.           non-IBM equipment, you should be able to do so with
  194.           no trouble.  Syslog is dependent only upon the DOS
  195.           interface to the computer for all hardware access.
  196.           This makes the program somewhat hardware
  197.           independent.
  198.  
  199.           Syslog must be run under DOS 2.0 or greater
  200.           operating systems.  Any attempt to run under earlier
  201.           versions of DOS result in the error message
  202.           'Incorrect DOS Version'.
  203.  
  204.           The program uses the system date and time to stamp
  205.           the entries in real time as they are entered.
  206.           Therefore, it is important that the date and time
  207.           are correctly set when the computer is first turned
  208.           on.  For this reason it is highly recommended that a
  209.           clock/calendar card be installed and used to set the
  210.           date/time when the computer is started.
  211.  
  212.                      -3-
  213.  
  214.  
  215.  
  216.  
  217.           Syslog expects to find the log file, SYSyy.LOG
  218.           (where yy is the current year), in the root
  219.           directory, although the program itself may reside
  220.           in any directory.  When the New Log option is used
  221.           to create a new log, Syslog will put the log in the
  222.           root directory of the default drive.  If you need
  223.           further explanation of the DOS root and sub
  224.           directories, see your MS-DOS manual for a complete
  225.           discussion of the topic.
  226.  
  227.           ____________________________________________________
  228.  
  229.                      -4-
  230.  
  231.  
  232.  
  233.           USING SYSLOG _______________________________________
  234.  
  235.           o  Getting Started
  236.  
  237.           In order to use Syslog you will first need to copy
  238.           the file 'SYSLOG.EXE' onto your boot disk.  Do this
  239.           with the DOS COPY command.
  240.  
  241.           o  Entering Parameters
  242.  
  243.           Syslog commands are entered as parameters.
  244.           Parameters are specified at the DOS prompt when the
  245.           program is executed.  This method should be familiar
  246.           since many DOS commands work in the same way.
  247.  
  248.           Upper or lower case letters may be used to enter
  249.           parameters.  Only one parameter may be used per
  250.           invocation of the the program; multiple parameters
  251.           are not supported.
  252.  
  253.           Some parameters also accept time and date qualifiers
  254.           to further limit their response.    Either '-' or '/'
  255.           may be used as separators in entering dates (ex.
  256.           1-1-84 or 7/4/84).
  257.  
  258.           When entering time data you must use military time
  259.           and ':' must be used to separate the numbers.  Only
  260.           hours and minutes are entered (ex.  7:45 or 17:00);
  261.           seconds are not used in any entries.  Military time
  262.           is very easy to use once you get the hang of it.
  263.           For any time after noon, simply add 12 to the hour.
  264.  
  265.           Appendix B contains a complete list of available
  266.           parameters.
  267.  
  268.           Note:  Syslog looks for the log file each time it is
  269.             run.  If the file is not found, the error
  270.             message 'System Log File Not Found' is
  271.             displayed.
  272.  
  273.           o  Setting up a Log - /N
  274.  
  275.           Before you can begin logging entries with Syslog you
  276.           will need to set up a new log file.  At the DOS
  277.           prompt type:  'SYSLOG/N [Return]'.
  278.  
  279.           Note:  The log file name is 'built' using the
  280.             current year.  Therefore, at the start of
  281.             each year you will need to start a new
  282.             log.
  283.  
  284.                      -5-
  285.  
  286.  
  287.  
  288.           You will then be prompted for the serial number of
  289.           the computer.  The serial number can be found on the
  290.           back panel of the system unit or on the shipping
  291.           container for the system unit.  Enter this number
  292.           and press [Return].
  293.  
  294.           A new log file will now be created in the root
  295.           directory of the default disk drive.  The file will
  296.           appear in the disk directory as 'SYSyy.LOG' (yy is
  297.           the current year).
  298.  
  299.           WARNING:    If the /N option is selected and a log
  300.             file is found to exist already, you will
  301.             be warned that continuing will permanently
  302.             erase the existing log.  Use caution, and
  303.             be sure of what you are doing!
  304.  
  305.           o  Making Log Entries - /I, /O
  306.  
  307.           There are two ways to make log entries, the first of
  308.           which is to login.  Login (/I) is used to create a
  309.           new entry in the log.  The second way to make a log
  310.           entry is to logout.  Logout (/O) is used to close an
  311.           existing entry.  In order to visualize what happens,
  312.           it is useful to understand what the log contains.
  313.  
  314.           The log is maintained with six pieces of information
  315.           in a completed entry: Date-In, Time-In, Operator,
  316.           Project, Date-Out, and Time-Out.
  317.  
  318.           Whenever a login is performed, the first four items
  319.           are filled in.  The computer will supply the date-in
  320.           and time-in, while you are required to enter the
  321.           operator and project.  The date-out and time-out are
  322.           left blank.  Log entries which do not yet have the
  323.           date-out and time-out completed are called OPEN
  324.           entries.    An open entry is always the result of a
  325.           successful login.
  326.  
  327.           Whenever a logout is performed, the date-out and
  328.           time-out information is completed.  Once the
  329.           date-out and time-out are entered, the entry is
  330.           CLOSED.  A closed entry is always the result of a
  331.           successful logout.
  332.  
  333.  
  334.                      -6-
  335.  
  336.  
  337.  
  338.           You are now ready to login; at the DOS prompt type:
  339.           'SYSLOG/I [Return]'.
  340.  
  341.           At the 'Oper :' prompt, enter the operators initials
  342.           and press [Return].  A maximum of three characters
  343.           may be entered for the operator; longer entries are
  344.           truncated.
  345.  
  346.           Next you will be prompted to enter a description of
  347.           the project. At the 'Project :' prompt you may enter
  348.           up to sixteen characters and then press [Return].
  349.           Again, longer entries will be truncated.
  350.  
  351.           Having now completed a login, you now have three
  352.           ways available to close the open entry just created.
  353.  
  354.           1.  Logout the entry using the current date and
  355.           time.  Type 'SYSLOG/O [Return]' at the DOS prompt.
  356.  
  357.           2.  Logout the entry using a specified date and
  358.           time.  Type 'SYSLOG/O hh:mm mm-dd-yy [Return]',
  359.           substituting the closing time and date that you
  360.           need.  The time may be specified alone and in that
  361.           case the current date will be used.  If the time and
  362.           date supplied precede the login date and time an
  363.           error results.
  364.  
  365.           3.  Logout the entry and then login a new entry.
  366.           Type 'SYSLOG/I [Return]' at the DOS prompt.  You
  367.           will be prompted for the closing date and time of
  368.           the open entry before the new entry is created.
  369.  
  370.           o  Display Last Entry - /L
  371.  
  372.           Sometimes you will want to look at the last entry in
  373.           the log.    The /L parameter displays the last log
  374.           entry on your display screen along with other
  375.           information about the log such as date started,
  376.           number of entries, status of last entry, and
  377.           computer serial number.  At the DOS prompt type:
  378.           'SYSLOG/L [Return]'.
  379.  
  380.           o  Printing the Log   - /P
  381.  
  382.           Printing the log is an essential feature.  If you
  383.           can't show your log to anyone, it won't be of much
  384.           use to you.  The /P parameter allows you to print
  385.           the current log or a log from any other year.  You
  386.           may also specify the date from which printing will
  387.           commence.
  388.  
  389.  
  390.                      -7-
  391.  
  392.  
  393.  
  394.           To print the entire contents of this year's log, the
  395.           /P parameter is used alone.  At the DOS prompt type:
  396.           'SYSLOG/P [Return]'.
  397.  
  398.           If you are interested in only printing a part of the
  399.           log, you can specify a date with the /P parameter
  400.           and Syslog will begin printing from that date
  401.           forward.    If, for example, you wanted to print the
  402.           log entries for the second half of 1984 you would
  403.           enter:  'SYSLOG/P 7-1-84 [Return]'.
  404.  
  405.           The same technique of specifying a date is used to
  406.           print a log from another year.  If you wanted to
  407.           print the entire 1983 log (assuming, of course, that
  408.           the 1983 log file is located in the root directory)
  409.           you would enter:    'SYSLOG/P 1-1-83 [Return]'.
  410.  
  411.           Terminate a long printout at any time by pressing
  412.           [Ctrl]-[Break].
  413.  
  414.           o  Erase Last Entry   - /E
  415.  
  416.           Occasionally it may be neccessary to erase an entry
  417.           which has been made incorrectly.    The /E parameter
  418.           has been provided for this purpose.  Erased entries
  419.           are not actually removed from the log.  The project
  420.           name is simply changed to read 'ERASED', and the
  421.           number of entries counter is decremented.  When the
  422.           log is printed, the erased entry will show up on the
  423.           list until a new entry is created to replace the
  424.           erased entry.
  425.  
  426.           At the DOS prompt type: 'SYSLOG/E [Return]'.
  427.  
  428.           Use of this feature should be limited due to the
  429.           fact that corruption of the log will make its use as
  430.           a reliable tax document subject to serious question.
  431.  
  432.           WARNING:    The /E option will permanently erase the
  433.             last entry.  You will be warned of this
  434.             and given the opportunity to stop.  Use
  435.             caution, and be sure of what you are
  436.             doing!
  437.  
  438.  
  439.                      -8-
  440.  
  441.  
  442.  
  443.           o Suggestions
  444.  
  445.           In actual use the program should be 'forced' upon
  446.           the computer user to insure that entries are
  447.           made in real time.  The best way to accomplish this
  448.           is to include the statement 'SYSLOG/I' in an
  449.           autoexec.bat file on the boot disk.  This technique
  450.           will force a login and allow the logout of an open
  451.           entry if one is found.
  452.  
  453.           If you are using any software to set the system
  454.           clock with a clock card, make sure that Syslog is
  455.           run AFTER the time and date have been correctly set.
  456.           If you do not have a clock card, include the two DOS
  457.           commands, DATE and TIME, in your autoexec.bat file.
  458.           DOS will not prompt you for the date and time when
  459.           an autoexec.bat fill is used.
  460.  
  461.           Log entries use 48 bytes each in disk storage space.
  462.           At 350 entries per year, this amounts to a log file
  463.           which will reach about 17K bytes over the course of
  464.           a year.  This is not a very large file; however, it
  465.           may exceed the available space on the DOS Disk if
  466.           you are using a single sided disk drive.
  467.  
  468.           One way to avoid this problem is to create a 'boot
  469.           disk' which you can always use to start up your
  470.           computer.  This would be a disk that contained only
  471.           those files needed at boot time, such as software to
  472.           set the system clock, electronic disks, print
  473.           spoolers, screen saver, etc.  (and DOS, of course).
  474.  
  475.           If you have any suggestions for improvements to
  476.           Syslog which would make it more useful, they will be
  477.           gratefuly received.
  478.  
  479.                 APEX RESOURCE
  480.                 23 Christine Court
  481.                 Stormville, NY    12582
  482.                 (914) 221-2611
  483.  
  484.           ____________________________________________________
  485.  
  486.           Appendix A
  487.  
  488.           PRODUCT REGISTRATION FORM __________________________
  489.  
  490.  
  491.           APEX RESOURCE                    SYSLOG
  492.           23 Christine Court                V1.1
  493.           Stormville, NY  12582
  494.           (914) 221-2611                    011485
  495.  
  496.           ____________________________________________________
  497.  
  498.  
  499.           My $25.00 is enclosed (NY Residents add $1.25 sales
  500.           tax).  Add me to the list of registered SYSLOG users
  501.           and send me a production copy of the program,
  502.           including:  program binder, diskette, and manual.
  503.  
  504.           I understand that registration also entitles me to
  505.           notification of future updates to the program as
  506.           well as free upgrades if I send in the original
  507.           serialized program diskette with a postage paid
  508.           return mailer.
  509.  
  510.           Oh!... I almost forgot... Please Hurry!!
  511.  
  512.  
  513.  
  514.           Shipping Information (Most orders shipped in 48 hrs)
  515.  
  516.           Name    ____________________________________________
  517.  
  518.           Company ____________________________________________
  519.  
  520.           Address ____________________________________________
  521.  
  522.           City    ____________________________________________
  523.  
  524.           State   _______________________    Zip ______________
  525.  
  526.           Phone   ____________________________________________
  527.  
  528.  
  529.  
  530.           Payment Information
  531.  
  532.           Check/Money Order ____   Master Card ____  VISA ____
  533.  
  534.           Credit Card Number _________________________________
  535.  
  536.           Credit Card Expiration Date ________________________
  537.  
  538.           Signature(if charging) _____________________________
  539.  
  540.           Appendix B
  541.  
  542.  
  543.  
  544.  
  545.           SYSLOG Parameters __________________________________
  546.  
  547.  
  548.           /P [date] - Print the contents of the log.  If a
  549.             date is supplied in the form mm-dd-yy, all
  550.             entries from that date to the present will
  551.             be printed.  If a date is specified, then
  552.             the year given will be used to select the
  553.             log file.
  554.  
  555.           /I - Make Log Entry.  The current date/time are used
  556.             for the new entry.  If a prior entry is
  557.             open, the user is prompted for the closing
  558.             time/date and the entry is closed before a
  559.             new entry is started.
  560.  
  561.           /O [time[date]] - Close Log Entry.  If a time/date
  562.             is supplied, then it will be used to close
  563.             the entry otherwise the current date and
  564.             time are used.
  565.  
  566.           /L - List Last Entry.
  567.  
  568.           /E - Erase Last Entry.
  569.  
  570.           /N - Start New Log.
  571.  
  572.           ____________________________________________________
  573.